Skip to main content
PATCH
Update an audience attribute

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Represents a audience attribute entity.

code
string
required

Code representing the audience attribute.

This code serves as a key for properties in both AudienceSegment and Audience.

Required string length: 1 - 32
Pattern: ^[a-z-]+$
id
string<uuid>
required
name
string
required

Name of the audience attribute

owner_id
string<uuid>
required

Owner ID of the audience attribute

visibility
enum<string>
required

Visibility of the audience attribute

Available options:
public,
private
created_at
string<date-time> | null

The date and time the entity was created.

deprecated
boolean
default:false
description
string | null

Description of the audience attribute

updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Represents a audience attribute entity.

code
string
required

Code representing the audience attribute.

This code serves as a key for properties in both AudienceSegment and Audience.

Required string length: 1 - 32
Pattern: ^[a-z-]+$
id
string<uuid>
required
name
string
required

Name of the audience attribute

no
integer
required
owner_id
string<uuid>
required

Owner ID of the audience attribute

value_count
integer
required

The number of the possible values of audience attribute

visibility
enum<string>
required

Visibility of the audience attribute

Available options:
public,
private
created_at
string<date-time> | null

The date and time the entity was created.

description
string | null

Description of the audience attribute

updated_at
string<date-time> | null

The date and time the entity was last updated.